sfdc-ux (LC)

1.0.x
(0 reviews)

Fetch SpendAndUsage Summary Details

Fetch SpendAndUsage summary details from SFTP Location

This operation is used to Fetch summary details from SFTP location based on AccountNumber and BillPeriod

[GET]

https://nonprod.lc.esb.cloud.lla.com/dev/sfdc-ux-lc/sfdc-ux/v1/{businessId}/spendAndUsageSummary
url Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (HN,CO,CR,GT,SV etc..) identifying the business unit.Expected: BS,BB,JM,VG,KN,AG,LC,KY,VC,GD,DM,AI,TTY
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request syntax: correlationId: uuid:cwc--, example: correlationId: f058ebd6-02f7-4d3f-942e-904344e8cde5Y
Query Params
nametypedescriptionrequired
accountNumberstringAccountNumberY
billPeriodstringBillPeriodY
Response
{
  "summary": [
    {
      "accountNo": "48809991",
      "period": "05_2026",
      "sourceSystem": "Liberate",
      "currency": "Ja$",
      "customerName": "TESTING",
      "generatedAt": "2026-06-23T12:26:01Z",
      "spendRecords": "10",
      "usageRecords": "15278",
      "spendByBusinessStructureElement": [
        {
          "businessStructureElement": "IT",
          "recordCount": "8",
          "currency": "Ja$",
          "netAmount": "19579.93",
          "vatAmount": "0",
          "totalAmount": "19579.93"
        },
        {
          "businessStructureElement": "Sales",
          "recordCount": "2",
          "currency": "Ja$",
          "netAmount": "2750",
          "vatAmount": "0",
          "totalAmount": "2750"
        }
      ],
      "spendByBusinessStructureElementGrandTotal": {
        "recordCount": "10",
        "currency": "Ja$",
        "netAmount": "22329.93",
        "vatAmount": "0",
        "totalAmount": "22329.93"
      },
      "usageByBusinessStructureElement": [
        {
          "businessStructureElement": "Sales",
          "recordCount": "15278",
          "voiceMinutes": "7897.05",
          "dataMB": "672760.09",
          "messages": "3423"
        }
      ],
      "usageByBusinessStructureElementGrandTotal": {
        "recordCount": "15278",
        "voiceMinutes": "7897.05",
        "dataMB": "672760.09",
        "messages": "3423"
      },
      "spendByServiceCategory": [
        {
          "serviceCategory": "Rental",
          "serviceType": "Monthly Rental",
          "chargeCategory": "Monthly Rental",
          "detail": "Business Ignite 400mbps",
          "recordCount": "1",
          "currency": "Ja$",
          "netAmount": "12500",
          "vatAmount": "0",
          "totalAmount": "12500"
        }
      ],
      "spendByServiceCategoryGrandTotal":
        {
        "recordCount": "10",
        "currency": "Ja$",
        "netAmount": "22329.93",
        "vatAmount": "0",
        "totalAmount": "22329.93"
      },
      "spendByServiceType": [
        {
          "serviceType": "Monthly Rental",
          "chargeCategory": "Monthly Rental",
          "detail": "Business Ignite 400mbps",
          "recordCount": "1",
          "currency": "Ja$",
          "netAmount": "12500",
          "vatAmount": "0",
          "totalAmount": "12500"
        }
      ],
      "spendByServiceTypeGrandTotal": {
        "recordCount": "10",
        "currency": "Ja$",
        "netAmount": "22329.93",
        "vatAmount": "0",
        "totalAmount": "22329.93"
      },
      "top25Spend": [
        {
          "period": "05_2026",
          "customerId": "99329393-3433",
          "customerName": "TESTING",
          "billingAccount": "362000380000",
          "lineOrService": "ETH8769854395",
          "chargeCategory": "Monthly Rental",
          "serviceCategory": "Rental",
          "serviceType": "Monthly Rental",
          "detail": "Business Ignite 400mbps",
          "currency": "Ja$",
          "netAmount": "12500",
          "vatAmount": "12500",
          "totalAmount": "12500",
          "businessStructureElement": "IT"
        }
      ],
      "top25Usage": [
        {
          "usageDates": "05-2026",
          "billedPeriod": "05_2026",
          "billingAccount": "362000380000",
          "documentNumber": "2026041-99329393-3433",
          "lineOrService": "5552019542",
          "chargeCategory": "Usage",
          "serviceCategory": "Mobile Data",
          "serviceType": "Mobile | Data | In Plan",
          "destinationAccessPoint": "",
          "destinationLocation": "",
          "unitsConsumed": "3381.72",
          "unit": "MB",
          "businessStructureElement": "IT"
        }
      ]
    }
  ]
}

Reviews